Update version to 1.21.11-2.72.1 and correct config path documentation#271
Merged
twisti-dev merged 2 commits intoversion/1.21.11from Mar 29, 2026
Merged
Update version to 1.21.11-2.72.1 and correct config path documentation#271twisti-dev merged 2 commits intoversion/1.21.11from
twisti-dev merged 2 commits intoversion/1.21.11from
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR bumps the project version and fixes SurfConfigApi’s JSON config manager factory to instantiate the correct JSON-based manager, plus updates documentation around the default config schema version key.
Changes:
- Bump release version from
1.21.11-2.72.0to1.21.11-2.72.1. - Fix
createSpongeJsonConfigManager(...)default overload to call the JSON manager factory (not the YAML one). - Update
SpongeConfigClassdocumentation to reflect the default version key"_config_version".
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/config/SurfConfigApi.kt | Fixes incorrect delegation for the JSON config manager factory overload. |
| surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/config/SpongeConfigClass.kt | Updates KDoc for the default schema version key path. |
| gradle.properties | Bumps the project version for the release. |
Comment on lines
112
to
116
| /** | ||
| * Sets the path in the config file where the version number is stored. | ||
| * | ||
| * Defaults to `"config-version"`. Call this in the `init` block before | ||
| * Defaults to `"_config_version"`. Call this in the `init` block before | ||
| * any migration registrations if you need a custom key. |
There was a problem hiding this comment.
The updated default version key here is now "_config_version", but ConfigMigrationBuilder.versionKey KDoc still states the default is "config-version" (see ConfigMigrationBuilder.kt). Consider updating that KDoc too so docs are consistent and users don’t get conflicting guidance on the default schema version path.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a version bump and fixes a critical configuration manager instantiation bug, along with a documentation update for config versioning. The most important changes are:
Versioning and release:
1.21.11-2.72.0to1.21.11-2.72.1ingradle.propertiesto reflect the new release.Configuration management:
SurfConfigApiwhere thecreateConfigManagermethod was incorrectly callingcreateSpongeYmlConfigManagerinstead ofcreateSpongeJsonConfigManager, ensuring the correct configuration manager is used for JSON configs.Documentation:
SpongeConfigClassto reflect that the default config version key is now"_config_version"instead of"config-version".